refactor: optimize Application Insights telemetry and prevent duplicate logging handlers by Harmanpreet-Microsoft · Pull Request #367 · microsoft/Modernize-your-code-solution-accelerator

Harmanpreet-Microsoft · 2026-03-16T12:57:29Z

This pull request improves the reliability and correctness of telemetry and logging integration in the backend, focusing on Application Insights and OpenTelemetry. It ensures proper deduplication of logging handlers, simplifies telemetry client initialization, and updates tests for better coverage and realistic configuration.

Telemetry and logging improvements:

Changed Application Insights telemetry client initialization in event_utils.py to use the default (buffered/async) channel configuration, removing custom synchronous channel setup. This simplifies the code and aligns with best practices.
Enhanced OpenTelemetry logging handler setup in app.py to remove stale handlers before adding a new one, preventing duplicate LoggingHandler instances and potential resource leaks. The handler is safely closed if removed.

Testing enhancements:

Updated test cases in event_utils_test.py to use a valid UUID format for the Application Insights instrumentation key, making tests more realistic and robust. [1] [2] [3] [4] [5]
Added a new test in app_test.py to verify that repeated calls to create_app() do not accumulate multiple LoggingHandler instances, ensuring proper deduplication and cleanup.
Minor test imports and setup improvements in app_test.py for logging and OpenTelemetry.

Other minor changes:

Cleaned up unused imports in event_utils.py related to Application Insights channel configuration.
Clarified event flushing logic in track_event_if_configured for immediate sending of telemetry events.

Does this introduce a breaking change?

Yes
No

Golden Path Validation

I have tested the primary workflows (the "golden path") to ensure they function correctly without errors.

Deployment Validation

I have validated the deployment process successfully and all services are running as expected with this change.

What to Check

Verify that the following are valid

...

Other Information

chore: sync psl-abhar with dev

…utils module

Copilot

Pull request overview

Refactors the backend’s Application Insights / OpenTelemetry telemetry setup to simplify client initialization and avoid duplicate log exporting during repeated app creation, and updates event-tracking tests to match the new behavior.

Changes:

Simplifies Application Insights TelemetryClient initialization by removing explicit synchronous channel setup.
Adds a guard to prevent adding duplicate OpenTelemetry LoggingHandler instances to the root logger.
Updates track_event_if_configured tests by removing flush() assertions.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 4 comments.

File	Description
`src/backend/api/event_utils.py`	Simplifies `TelemetryClient` initialization and tweaks `flush()` call/comment formatting.
`src/backend/app.py`	Prevents duplicate OpenTelemetry logging handlers on the root logger.
`src/tests/backend/api/event_utils_test.py`	Removes `flush()` assertions from telemetry event tracking tests.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

src/tests/backend/api/event_utils_test.py

src/backend/app.py

…ensure flush is called

Copilot

Pull request overview

Refactors backend telemetry wiring to simplify Application Insights client initialization and reduce duplicated OpenTelemetry log handlers, aiming to improve runtime behavior during reload/testing and streamline telemetry configuration.

Changes:

Removed explicit synchronous Application Insights channel setup and rely on TelemetryClient defaults.
Added root logger LoggingHandler de-duplication logic to avoid accumulating duplicate OTel handlers.
Adjusted comments around event flushing behavior.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.

File	Description
`src/backend/app.py`	Removes existing OTel `LoggingHandler` instances from the root logger before adding a fresh one tied to the current `logger_provider`.
`src/backend/api/event_utils.py`	Simplifies `TelemetryClient` initialization by removing the explicit synchronous channel and keeps explicit `flush()` after event tracking.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

src/backend/api/event_utils.py

src/backend/app.py

src/tests/backend/app_test.py

Copilot

Pull request overview

Refactors backend telemetry and logging initialization to simplify Application Insights client setup and avoid duplicated OpenTelemetry log handlers when the app is created multiple times (e.g., tests/hot-reload).

Changes:

Simplified Application Insights TelemetryClient initialization by removing explicit synchronous channel wiring.
Updated create_app() logging setup to remove existing OpenTelemetry LoggingHandler instances before adding a new one.
Minor refactor/comment tweak around event flushing; test module imports were updated (but currently appear unused).

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.

File	Description
`src/backend/app.py`	Deduplicates OpenTelemetry `LoggingHandler` on the root logger during app startup.
`src/backend/api/event_utils.py`	Uses default `TelemetryClient` channel config instead of explicit synchronous channel types; keeps explicit flush.
`src/tests/backend/app_test.py`	Adds imports intended for telemetry/logging-related testing, but no assertions yet.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

src/tests/backend/app_test.py

src/backend/app.py

…st imports

src/tests/backend/app_test.py

…eduplication test

src/tests/backend/app_test.py

… variable assignments and enhance error logging during cleanup

Harmanpreet-Microsoft added 2 commits March 16, 2026 13:43

Merge pull request #366 from microsoft/dev

fe488a9

chore: sync psl-abhar with dev

Refactor telemetry client initialization and event tracking in event_…

3685020

…utils module

Harmanpreet-Microsoft requested review from Avijit-Microsoft, Prajwal-Microsoft, Roopan-Microsoft, Vinay-Microsoft, aniaroramsft, dgp10801, marktayl1, nchandhi and toherman-msft as code owners March 16, 2026 12:57

Harmanpreet-Microsoft temporarily deployed to production March 16, 2026 12:57 — with GitHub Actions Inactive

Fix import order and clean up whitespace in event_utils module

936272c

Harmanpreet-Microsoft temporarily deployed to production March 16, 2026 12:58 — with GitHub Actions Inactive

Harmanpreet-Microsoft requested a review from Copilot March 16, 2026 12:59

Copilot started reviewing on behalf of Harmanpreet-Microsoft March 16, 2026 12:59 View session

Refactor import statements in event_utils module

fac6196

Harmanpreet-Microsoft temporarily deployed to production March 16, 2026 13:01 — with GitHub Actions Inactive

Copilot AI reviewed Mar 16, 2026

View reviewed changes

src/tests/backend/api/event_utils_test.py Show resolved Hide resolved

src/tests/backend/api/event_utils_test.py Show resolved Hide resolved

src/tests/backend/api/event_utils_test.py Show resolved Hide resolved

src/backend/app.py Outdated Show resolved Hide resolved

Enhance OpenTelemetry logging handler management and update tests to …

2390c72

…ensure flush is called

Harmanpreet-Microsoft temporarily deployed to production March 16, 2026 13:06 — with GitHub Actions Inactive

Harmanpreet-Microsoft requested a review from Copilot March 16, 2026 13:07

Copilot started reviewing on behalf of Harmanpreet-Microsoft March 16, 2026 13:08 View session

Copilot AI reviewed Mar 16, 2026

View reviewed changes

src/backend/api/event_utils.py Show resolved Hide resolved

src/backend/api/event_utils.py Show resolved Hide resolved

src/backend/app.py Show resolved Hide resolved

src/backend/app.py Show resolved Hide resolved

Add handler closure in logging setup and update test imports

df015b9

Harmanpreet-Microsoft temporarily deployed to production March 16, 2026 13:15 — with GitHub Actions Inactive

Harmanpreet-Microsoft requested a review from Copilot March 16, 2026 13:16

Copilot started reviewing on behalf of Harmanpreet-Microsoft March 16, 2026 13:16 View session

github-code-quality bot found potential problems Mar 16, 2026

View reviewed changes

src/tests/backend/app_test.py Fixed Show fixed Hide fixed

src/tests/backend/app_test.py Fixed Show fixed Hide fixed

src/tests/backend/app_test.py Fixed Show fixed Hide fixed

Copilot AI reviewed Mar 16, 2026

View reviewed changes

src/tests/backend/app_test.py Show resolved Hide resolved

src/backend/app.py Outdated Show resolved Hide resolved

src/backend/app.py Show resolved Hide resolved

Enhance error handling during logging handler closure and clean up te…

8a64e5c

…st imports

Harmanpreet-Microsoft temporarily deployed to production March 16, 2026 13:23 — with GitHub Actions Inactive

Add test for LoggingHandler deduplication in app creation

8a668fd

Harmanpreet-Microsoft temporarily deployed to production March 16, 2026 13:36 — with GitHub Actions Inactive

github-code-quality bot found potential problems Mar 16, 2026

View reviewed changes

src/tests/backend/app_test.py Fixed Show fixed Hide fixed

src/tests/backend/app_test.py Fixed Show fixed Hide fixed

src/tests/backend/app_test.py Fixed Show fixed Hide fixed

Update instrumentation key in event_utils tests and logging handler d…

2b48edb

…eduplication test

Harmanpreet-Microsoft temporarily deployed to production March 16, 2026 13:42 — with GitHub Actions Inactive

github-code-quality bot found potential problems Mar 16, 2026

View reviewed changes

src/tests/backend/app_test.py Fixed Show fixed Hide fixed

src/tests/backend/app_test.py Fixed Show fixed Hide fixed

src/tests/backend/app_test.py Fixed Show fixed Hide fixed

Refactor logging handler deduplication test to remove unnecessary app…

1152818

… variable assignments and enhance error logging during cleanup

Harmanpreet-Microsoft temporarily deployed to production March 16, 2026 13:47 — with GitHub Actions Inactive

Add missing import for os module in event_utils.py

fb094c8

Harmanpreet-Microsoft temporarily deployed to production March 16, 2026 13:49 — with GitHub Actions Inactive

Harmanpreet-Microsoft changed the base branch from main to dev March 16, 2026 14:15

Conversation

Harmanpreet-Microsoft commented Mar 16, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Does this introduce a breaking change?

Golden Path Validation

Deployment Validation

What to Check

Other Information

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Harmanpreet-Microsoft commented Mar 16, 2026 •

edited

Loading